﻿// Copyright 2009 Mike Geise
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
//     http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

namespace Falcon.Core.Domain.Services
{
	using Falcon.Core.Domain.Values;

	public interface IAuthenticationService
	{
		/// <summary>
		/// Gets the return URL.
		/// </summary>
		/// <value>The return URL.</value>
		string ReturnUrl { get; }

		/// <summary>
		/// Gets the login URL.
		/// </summary>
		/// <value>The login URL.</value>
		string LoginUrl { get; }

		/// <summary>
		/// Authenticates the current user
		/// </summary>
		/// <param name="value">The <see cref="UserAuthentication"/>.</param>
		void Login(UserAuthentication value);

		/// <summary>
		/// Logout the current user
		/// </summary>
		void Logout();

		/// <summary>
		/// Reset the user password
		/// </summary>
		/// <param name="value">The <see cref="UserAuthenticationReset"/>.</param>
		void Reset(UserAuthenticationReset value);

		/// <summary>
		/// Update the user password
		/// </summary>
		/// <param name="value">The <see cref="UserAuthenticationUpdate"/>.</param>
		void Update(UserAuthenticationUpdate value);
	}
}